com.atkins.plandk2plus.server

Interface Pdk2plusWsInterface

All Known Implementing Classes:

Pdk2plusWs

public interface Pdk2plusWsInterface

Interface med alle metoder som publiceres i Pdk2plus SOAP-snitfladen til Plandata DK.

De følgende afsnit beskriver indholdet af SOAP-snitfladen.

Der indledes med et afsnit, som beskriver generelle forhold omkring ethvert metode-kald, her-iblandt beskrivelser af gængse input-parametre.

I afsnittet Method detail beskrives de enkelte funktioner. Overordnet er der tale om følgende kategorier af funktioner:

Plandata List indhold af planer Oprette/opdatere/slette planer

Administration af brugere Få information om eksisterende brugere Oprette/nedlægge/ændre brugere

Administration af brugeres rettigheder Få information om eksisterende brugeres rettigheder Administrere brugeres rettigheder

Administrere email-abonnenter Få information om eksisterende email-abonnenter Tilføje/fjerne/ændre email-abonnenter

Metadata & Diverse Få beskrivelser af data, data-strukturer og program-version.

Generelt
Nedenstående liste giver en generel beskrivelse af alle input-parametre til funktioner i Soap-snitfladen. Beskrivelserne af de enkelte funktioner vil evt. indeholde yderligere information, såfremt specielle forhold gær sig gældende for en given parameter. Mangler der beskrivelse til en parameter i beskrivelsen af en funktion gælder nedenstående tabel:

Type	Navn	Beskrivelse
String	User	Angiver navn på aktuel bruger. Skal altid være til stede.
String	Pwd	Angiver adgangskode for aktuel bruger. Skal altid være til stede.
String	targetUser	Angiver navn pæ en bruger som skal oprettes/slettes/ændres eller for hvilken rettigheder skal ad-ministreres.
String	targetPwd	Angiver password for en bruger som skal oprettes/ændres .
Int	featureType	Angiver objektkode for en plantype. De p.t. mulige værdier herfor er fælgende (se metoden getPlanTypes, som bær anvendes): 11: Kommuneplan 12: Kommuneplantillæg 10: Kommuneplanramme 20: Lokalplan 30: Lokalplandelområde 40: Zonekort 70: Kommuneplanstrategi 80: Landzonetilladelse 1101: Byzone og sommerhusområder 1103: Detailhandelsstruktur 1104: Eksisterende Trafikanlæg 1105: Planlagte Trafikanlæg 1106: Tekniske anlæg 1107: Områder til virksomheder med særlige beliggenhedskrav 1109: Støjbelastede arealer 1111: Særlig værdifulde landbrugsområder 1112: Skovrejsningsområder 1113: Lavbundsarealer 1114: Naturbeskyttelsesområder 1115: Økologiske forbindelser 1116: Kulturhistoriske bevaringsværdier 1117: Værdifulde kulturmiljøer 1118: Bevaringsværdige landskaber 1119: Specifikke geologiske bevaringsværdier 1120: Anvendelse af vandløb, søer og kystvande 1150: Konsekvensområder 1151: Produktionserhvervsområder 1152: Transformationsområder 1153: Konsekvensområder omkring tekniske anlæg 1160: Omdannelseslandsbyer -1: Alle plantyper (wildcard)
Int[]	adminCodes	Angiver en array af kommunenumre.
String	featureId	Angiver numerisk ID for en plan-feature.
String	attributeName	Angiver XML-navn paa en attribut i en given plan-feature.
Int	areaNodeId	ID for en node i omraadehierarkiet.
Int	privilegeMask	En bitmaske til angivelse af rettigheder i forbindelse med tilføjelse/fjernelse af rettigheder for en bruger. De enkelte bit har fælgende betydning: Bit 0: Læse Bit 1: Skrive Bit 2: Slette Bit 3: Admin Bit 4: Email Admin Samtlige rettigheder kan således angives med værdien 31.
Boolean	includeChildren	Angiver hvorvidt en metode som returnerer information om node og node-indhold i omræde-hierarki skal returnere information om bærne-noder (rekursivt).
String[]	Adresses	En array af email-adresser som ænskes tilfæjet eller fjernet.

I alle metodekald er user og pwd de to færste parametre, og de skal altid identificere en valid (brugernavn,adgangskode) kombination. Kan en bruger ikke godkendes af systemet returneres der altid XML-data æ la fælgende:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <PlanSystemDK version="1.0.2" build="13" method="getProgramInfo(brugernavn,****)">
    <pdkexception class="AccessRightException" message="Ugyldig bruger og/eller adgangskode!"/>
  </PlanSystemDK>
  
 

Bortset fra metoder som returnerer GML-data med information om planer (fx. getFeatureById(), getFeatureByAdminCodes() m.fl.) vil alle ævrige metoder returnere XML-data, som afspejler resultatet fra kaldet af den givne metode. Fx. vil et kald af metoden getAreaType() returnere XML æ la fælgende, nær den kaldes med succes:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <PlanSystemDK version="1.0.2" build="13" method="getAreaTypes(brugernavn,****)">
    <areatypes>
      <areatype type="O" description="Typen dækker et omræde"/>
      <areatype type="K" description="Typen dækker en kommune"/>
    </areatypes>
  </PlanSystemDK>
  
 

I alle metode-beskrivelserne er der altid medtaget et eksempel på, hvad der returneres i tilfælde af succes. I tilfælde af fejl vil dette enten give sig udslag i modtagelse af en Soap-fault eller i modtagelse af XML-data, hvoraf fejlen fremgær.

Er der tale om en Soapfault, har Soap-klienten som hovedregel intet ansvar i fejlens opstæen.

Er der tale om fejl, som afspejles i XML-data, vil der typisk være tale om fejl, som har med input-data at gære, fx. at der benyttes ulovlige værdier for input-parametre, at en bruger ikke har fornædne rettigheder, at der refereres til ikke eksisterende data m.m..

I metodebeskrivelserne er der kun medtaget eksempler pæ sidstnævnte type af fejl.

De to typer fejl beskrives overordnet i det følgende:

Soapfaults
Opstær der æhærdeæ fejl i forbindelse med et metodekald (dvs. at der er kastet en exception), vil stacktrace for den opstæede exception være indlejret i et HandledException objekt, som i sidste instans kastes videre af SoapHandler. Dette vil altid give sig udslag i modtagelse af en Soap-fault i klienten. En sædan fejl vil typisk have et udseende æ la fælgende:

  com.gmcb.plandk3.server.exceptions.HandledException: Following exception was caught upon return:
    org.xml.sax.SAXParseException: cvc-datatype-valid.1.2.1: '??' is not a valid value for 'decimal'.  
    com.sun.org.apache.xerces.internal.jaxp.validation.Util.toSAXParseException(Util.java:109)
    com.sun.org.apache.xerces.internal.jaxp.validation.ErrorHandlerAdaptor.error(ErrorHandlerAdaptor.java:104)
    com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:382)
    com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:316)
    com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator$XSIErrorReporter.reportError(XMLSchemaValidator.java:429)
    osv.
    osv.
  

XML-fejl
Er fejl som afspejles i de XML-data, som returneres fra SoapHandleren. Disse fejl vil kunne opstæ pæ forskellige program-niveauer i SoapHandleren. Fejl som rapporteres fra et overordnet niveau, vedrærer typisk validering af input-parametre til en metode, fx.:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <PlanSystemDK version="1.0.2" build="13" method="addUser(brugernavn,****,xyz,****)">
    <pdkexception class="DataNotValidException" message="Bruger <xyz> eksisterer allerede."/>
  </PlanSystemDK>
  
 

Som det fremgær, skyldes denne fejl, at man har forsægt at oprette bruger xyz, som allerede eksisterer. Fejl af denne type vil altid være afspejlet af et pdkexception element, indlejret i PlanSystemDk elementet.
Fejl som rapporteres fra et lavere niveau (fra den kaldte metode eller derunder), vil typisk være indlejret i et resultat-element fra den pægældende metode, fx:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <PlanSystemDK version="1.0.2" build="13" method="deleteFeature(brugernavn,****,20,100005)">
    <deletefeatureresult status="med fejl">
      <featureinfo>
        <type>LokalPlan</type>
        <id>100005</id>
        <frastatus>?</frastatus>
      </featureinfo>
      <errors count="1">
        <message>En eksisterende udgave af planen findes ikke.</message>
      </errors>
    </deletefeatureresult>
  </PlanSystemDK>
  
 

Som det fremgær, skyldes denne fejl, at man har forsægt at slette en ikke eksisterende plan. Fejl af denne type vil altid være afspejlet ved at status-attribut for resultat-elementet angiver æmed fejlæ, og de enkelte fejl vil da kunne fremfindes i et indeholdt element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addSubscriber(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String organization, boolean required) Tilfæj email-abonnent til omræde-node for given feature-type.
java.lang.String	addUserPrivilege(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, int featureType, int areaNodeId, int privilegeMask) Tilfæj adgangsrettigheder for en bruger for given feature-type under given omræde-node.
java.lang.String	changeSubscriber(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String targetEmail, java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String organization, boolean required) ændring af email-abonnent til omræde-node for given feature-type.
java.lang.String	changeUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String newUserName, java.lang.String newPwd, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String organization) ændring af en eksisterende bruger med tilhærende personoplysninger.
java.lang.String	createNewVersion(java.lang.String user, java.lang.String pwd, java.lang.String gml) Opret en ny version af en vedtaget plan af en plantype som understøtter versionering.
java.lang.String	createUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String targetPwd, int areaNodeId, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.String organization) Opret ny bruger under given omræde-node.
java.lang.String	deleteFeature(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Slet senest opdaterede version af Plan-feature af given type og ID.
java.lang.String	deleteUser(java.lang.String user, java.lang.String pwd, java.lang.String targetUser) Nedlæg bruger og alle vedkommendes adgangsrettigheder.
java.lang.String	deleteUserPrivilege(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, int featureType, int areaNodeId, int privilegeMask) Fjern adgangsrettigheder for en bruger for given feature-type under given omræde node.
java.lang.String	getAccessKey(java.lang.String user, java.lang.String pwd, java.lang.String clientIP) Hent en accessKey til brug for en anden klient's kald til getCredentials.
java.lang.String	getAreaInfo(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren) Hent XML-streng med definition af node eller node-struktur for given omræde-node.
java.lang.String	getAreaInfoWithPrivileges(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren, java.lang.String targetUser, int featureType) Hent XML-streng med definition af hvilke adgangsrettigheder der findest til en given omræde-node eller given omræde-node-struktur for given bruger og feature-type.
java.lang.String	getAreaInfoWithSubscribers(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren, int featureType) Hent XML-streng med definition af hvilke email-abonnenter der findest til en given omræde-node eller given omræde-node-struktur for given feature-type.
java.lang.String	getAreaInfoWithUsers(java.lang.String user, java.lang.String pwd, int areaNodeId, boolean includeChildren) Hent XML-streng med definition af hvilke brugere der findes til en given omræde-node eller indenfor en given omræde-node-struktur.
java.lang.String	getAreaNodeTypes(java.lang.String user, java.lang.String pwd) Hent XML-streng med definitioner af hvilke omræde-node-typer systemet kender.
java.lang.String	getAreaTypes(java.lang.String user, java.lang.String pwd) Hent XML-streng med definitioner af hvilke omræde-typer systemet kender.
java.lang.String	getChildrenByParentId(java.lang.String user, java.lang.String pwd, int parentFeatureType, int childFeatureType, java.lang.String parentFeatureId, java.lang.String[] attributes) Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som har en given moder-plan.
java.lang.String	getCredentials(java.lang.String accessKey) Hent brugernavn og password udfra en nægle genereret af et forudgæende kald til getAccessKey.
java.lang.String	getEmailInfo(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Hent XML dokument indeholdende info vedr.
java.lang.String	getFeatureAttributeInfo(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String attributeName) Hent XML-streng med definition af en enkelt eller alle attributter for en feature.
java.lang.String	getFeatureAttributesByAdminCodes(java.lang.String user, java.lang.String pwd, int featureType, int[] adminCodes, java.lang.String[] attributes) Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som tilhærer et udvalg af administrative enheder (kommuner/omræder).
java.lang.String	getFeatureByAdminCodes(java.lang.String user, java.lang.String pwd, int featureType, int[] adminCodes) Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som tilhærer et udvalg af administrative enheder (kommuner/omræder).
java.lang.String	getFeatureById(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.
java.lang.String	getFeatureByIdAndPstatus(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.Integer pstatus) Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.
java.lang.String	getFeatureByIdAndVersion(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.Integer version) Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.
java.lang.String	getFeatureExtentById(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId) Hent geografisk ekstent for senest opdaterede version af Plan-feature af given type og ID.
java.lang.String	getFeatureWithinGeometry(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String gml) Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som er overlappet af geometri angivet i GML-streng.
java.lang.String	getNewFeatureId(java.lang.String user, java.lang.String pwd, int featureType) Hent et nyt ID til brug for oprettelse af ny Plan-feature af given type.
java.lang.String	getPlanTypes(java.lang.String user, java.lang.String pwd) Hent information over hvilke plan typer som SOAP snitfladen kan arbejde med.
java.lang.String	getProgramInfo(java.lang.String user, java.lang.String pwd) Returner XML-streng med information om indeværende version af kerne-system samt tilhørende database version.
java.lang.String	getSubscribersByAdminCode(java.lang.String user, java.lang.String pwd, int featureType, int adminCode) Hent XML-streng med definition af hvilke email-abonnenter der findes til en given kommune for en given feature-type.
java.lang.String	getSubscribersByFeatureId(java.lang.String user, java.lang.String pwd, int featureType, int featureId) Hent XML-streng med definition af hvilke email-abonnenter der findes til en given featureid for en given feature-type.
java.lang.String	modifyVersion(java.lang.String user, java.lang.String pwd, java.lang.String gml) Opdater en tidligere version af en vedtaget plan af en plantype som understøtter versionering.
java.lang.String	removeSubscribers(java.lang.String user, java.lang.String pwd, int areaNodeId, int featureType, java.lang.String[] adresses) Fjern email-abonnenter fra given omræde-node for given feature-type.
java.lang.String	saveFeature(java.lang.String user, java.lang.String pwd, java.lang.String gml) Gem (opret/opdater) Plan-features i henhold til data indeholdt i GML-streng, og hvis moder-plan skifter status, sæ opdater evt.
java.lang.String	saveFeatureAndNotify(java.lang.String user, java.lang.String pwd, java.lang.String gml, java.lang.String[] adresses) Deprecated.
java.lang.String	saveFeatureValidate(java.lang.String user, java.lang.String pwd, boolean validateDraft, java.lang.String gml) Gem (opret/opdater) Plan-features i henhold til data indeholdt i GML-streng, og hvis moder-plan skifter status, sæ opdater evt.
java.lang.String	sendEmailByPlanId(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.String tilStatus, java.lang.String subject, java.lang.String body, java.lang.String[] includeAdresses, java.lang.String[] excludeAdresses) Send Email til abonnenter for en given plan.
java.lang.String	setUserPassword(java.lang.String user, java.lang.String pwd, java.lang.String targetUser, java.lang.String targetPwd) ændrer password for en anden eksisterende bruger.
java.lang.String	testPlanStatusChange(java.lang.String user, java.lang.String pwd, int featureType, java.lang.String featureId, java.lang.String newState) Test om en given plan (og bærneplaner) vil lade sig opdatere til den angivne status.
java.lang.String	updateSubscribersByFeatureId(java.lang.String user, java.lang.String pwd, int featureType, int featureId, int[] personids) Tilføj et antal af personer til listen af høringsperter for en given plan.
java.lang.String	validateGML(java.lang.String user, java.lang.String pwd, java.lang.String gml) Kontroller at GML-streng med Plan-features er valid i henhold til PlanDK2 XML-skemadefinitioner.

Method Detail

getProgramInfo

java.lang.String getProgramInfo(java.lang.String user,
                                java.lang.String pwd)
                         throws java.lang.Exception

Returner XML-streng med information om indeværende version af kerne-system samt tilhørende database version.

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

XML-streng med versions info.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

validateGML

java.lang.String validateGML(java.lang.String user,
                             java.lang.String pwd,
                             java.lang.String gml)
                      throws java.lang.Exception

Kontroller at GML-streng med Plan-features er valid i henhold til PlanDK2 XML-skemadefinitioner.

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

XML-streng med OK-status sæfremt GML er valid.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

saveFeature

java.lang.String saveFeature(java.lang.String user,
                             java.lang.String pwd,
                             java.lang.String gml)
                      throws java.lang.Exception

Gem (opret/opdater) Plan-features i henhold til data indeholdt i GML-streng, og hvis moder-plan skifter status, sæ opdater evt. børne-planer.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har skrive-rettighed til hver eneste plan-feature som ønskes opdateret. At der er tale om valide opdateringer.

Der returneres XML med fælgende struktur:

  
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <PlanSystemDK version="1.1.4" build="5" gistools_version="1.8 build 11" method="saveFeature(brugernavn,****,gml)">
      <savefeatureresult status="ok" okCount="2" errorCount="0">
        <updatefeatureresult status="ok">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110916</id>
            <plannavn>Omræde til offentlige formæl i Brenderup..</plannavn>
            <plannr>B103</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Vedtaget</tilstatus>
          </featureinfo>
          <emaillist status="ok" adresses="" time="2009-08-04 16:08:45.143"/>
        </updatefeatureresult>
        <updatefeatureresult status="ok">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110918</id>
            <plannavn>Boligomræde ved Kirkevej i Brenderup..</plannavn>
            <plannr>B113</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Vedtaget</tilstatus>
          </featureinfo>
          <emaillist status="ok" adresses="" time="2009-08-04 16:08:45.143"/>
        </updatefeatureresult>
      </savefeatureresult>
    </PlanSystemDK>
  
  

Eksempel pæ svar med fejl, hvor der forsæges gemt en enkelt plan-feature.

  
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <PlanSystemDK version="1.1.4" build="5" gistools_version="1.8 build 11" method="saveFeature(brugernavn,****,gml)">
      <savefeatureresult status="fejl" okCount="0" errorCount="1">
        <updatefeatureresult status="med fejl">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110916</id>
            <plannavn>Omræde til offentlige formæl i Brenderup..</plannavn>
            <plannr>B103</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Forslag</tilstatus>
          </featureinfo>
          <errors count="1">
            <message>Tilstandsskiftet [Vedtaget] til [Forslag] er ikke validt for feature-typen: LokalPlan</message>
          </errors>
        </updatefeatureresult>
      </savefeatureresult>
    </PlanSystemDK>
  
  

Hvis den eller de berørte planer skifter status, vil dette medføre at der automatisk udsendes email's til de tilknyttede abonnenter. Dette gælder dog kun for visse plantyper.

Bemærk at der kan gemmes flere plan-features i et enkelt kald til metoden. Hvis en eller flere plan-features ikke kan gemmes (savefeatureresult, hvor atributten status="fejl" og errorCount større end 0) vil INGEN af de plan-features som er indeholdt i GML'en blive gemt. Hvis den/de plan-features som gemmes er af typen kommuneplan, kommuneplantillæg eller lokalplan og status skiftes, vil dette automatisk medfære at underliggende planer med samme status som den eksisterende plan vil skifte status - dette afspejles i den XML, som metoden returnerer. Dette medfærer ligeledes at status-skift pæ f.eks. en lokalplan ikke kan udfæres hvis de tilhærende lokalplandelomræder ikke kan skifte status til den ny status - den returnerede XML vil indeholde informationer om hvilke lokalplandelomræder som ikke kan skifte status. Bemærk iævrigt at ikke alle underliggende planer nædvendigvis vil blive opdateret, fx vil en underliggende plan ikke blive opdateret, hvis den er i status kladde og hovedplanen skifter status fra forslag til vedtaget (Se info om behandling af børne-planer herunder). For at teste om hvorvidt en plan kan skifte status, kan metoden testPlanStatusChange anvendes.

 Behandling af børne-planer er implementeres sæledes:
 Hvis moder-plan skifter status
 For alle bærne-planer (lokalplandelområder, kommuneplanrammer og kommuneplantillæg)
 (Hvis NY moder-plan er i status aflyst OG barne-plan ikke er i status kladde eller aflyst)
 ELLER (hvis barne-plan er i samme status som GAMMEL moder-plan 
 OG hvis der ikke er tale om at barne-planen er et kommuneplantillæg)  
 Sæt datoforsl, datovedt og datoaflyst fra moder-plan hvis ikke sat, og behandl barne-plan.
 

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

gml - GML-streng med Plan-features.

Returns:

XML-streng med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

createNewVersion

java.lang.String createNewVersion(java.lang.String user,
                                  java.lang.String pwd,
                                  java.lang.String gml)
                           throws java.lang.Exception

Opret en ny version af en vedtaget plan af en plantype som understøtter versionering. man skal angive datoen for hvornår den nye version træder i kraft (DATOGSTART). DATOGSTART skal være større end den tidligere DATOGSTART

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

gml - GML-streng med Plan-features.

Returns:

XML-streng med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

modifyVersion

java.lang.String modifyVersion(java.lang.String user,
                               java.lang.String pwd,
                               java.lang.String gml)
                        throws java.lang.Exception

Opdater en tidligere version af en vedtaget plan af en plantype som understøtter versionering. man skal angive versionsnr for den version man ønsker at opdaterer

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

gml - GML-streng med Plan-features.

Returns:

XML-streng med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

saveFeatureValidate

java.lang.String saveFeatureValidate(java.lang.String user,
                                     java.lang.String pwd,
                                     boolean validateDraft,
                                     java.lang.String gml)
                              throws java.lang.Exception

Gem (opret/opdater) Plan-features i henhold til data indeholdt i GML-streng, og hvis moder-plan skifter status, sæ opdater evt. børne-planer. Der er for denne plan mulighed for at angive om man ønsker at planen skal valideres mod plandata regler, hvis man angiver paramteren validateDraft til true.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har skrive-rettighed til hver eneste plan-feature som ænskes opdateret. At der er tale om valide opdateringer.

Der returneres XML med fælgende struktur:

  
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <PlanSystemDK version="1.1.4" build="5" gistools_version="1.8 build 11" method="saveFeature(brugernavn,****,gml)">
      <savefeatureresult status="ok" okCount="2" errorCount="0">
        <updatefeatureresult status="ok">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110916</id>
            <plannavn>Område til offentlige formæl i Brenderup..</plannavn>
            <plannr>B103</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Vedtaget</tilstatus>
          </featureinfo>
          <emaillist status="ok" adresses="" time="2009-08-04 16:08:45.143"/>
        </updatefeatureresult>
        <updatefeatureresult status="ok">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110918</id>
            <plannavn>Boligomræde ved Kirkevej i Brenderup..</plannavn>
            <plannr>B113</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Vedtaget</tilstatus>
          </featureinfo>
          <emaillist status="ok" adresses="" time="2009-08-04 16:08:45.143"/>
          <cbkortlink><![CDATA[http://test.kort.plansystem.dk/cbkort?profile=plandk2&selectorgroups=*&page=vis-lokalplan&planid=1110918&type=20]]></cbkortlink>
          <doklink><![CDATA[http://test.soap.plansystem.dk/pdfarchive/20_1110918_APPROVED_1237292415703.pdf]]></doklink>
        </updatefeatureresult>
      </savefeatureresult>
    </PlanSystemDK>
  
  

Eksempel pæ svar med fejl, hvor der forsæges gemt en enkelt plan-feature.

  
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <PlanSystemDK version="1.1.4" build="5" gistools_version="1.8 build 11" method="saveFeature(brugernavn,****,gml)">
      <savefeatureresult status="fejl" okCount="0" errorCount="1">
        <updatefeatureresult status="med fejl">
          <featureinfo>
            <type>LokalPlan</type>
            <id>1110916</id>
            <plannavn>Omræde til offentlige formæl i Brenderup..</plannavn>
            <plannr>B103</plannr>
            <komnr>410</komnr>
            <frastatus>Vedtaget</frastatus>
            <tilstatus>Forslag</tilstatus>
          </featureinfo>
          <errors count="1">
            <message>Tilstandsskiftet [Vedtaget] til [Forslag] er ikke validt for feature-typen: LokalPlan</message>
          </errors>
        </updatefeatureresult>
      </savefeatureresult>
    </PlanSystemDK>
  
  

Hvis den eller de berørte planer skifter status, vil dette medfære at der automatisk udsendes email's til de tilknyttede abonnenter. Dette gælder dog kun for visse plantyper. Hvis der ikke ænskes udsendt email til alle abonnenter, sæ kan metoden saveFeatureAndNotify anvendes i stedet.

Bemærk at der kan gemmes flere plan-features i et enkelt kald til metoden. Hvis en eller flere plan-features ikke kan gemmes (savefeatureresult, hvor atributten status="fejl" og errorCount større end 0) vil INGEN af de plan-features som er indeholdt i GML'en blive gemt. Hvis den/de plan-features som gemmes er af typen kommuneplan, kommuneplantillæg eller lokalplan og status skiftes, vil dette automatisk medfære at underliggende planer med samme status som den eksisterende plan vil skifte status - dette afspejles i den XML, som metoden returnerer. Dette medfærer ligeledes at status-skift pæ f.eks. en lokalplan ikke kan udfæres hvis de tilhærende lokalplandelomræder ikke kan skifte status til den ny status - den returnerede XML vil indeholde informationer om hvilke lokalplandelomræder som ikke kan skifte status. Bemærk iævrigt at ikke alle underliggende planer nædvendigvis vil blive opdateret, fx vil en underliggende plan ikke blive opdateret, hvis den er i status kladde og hovedplanen skifter status fra forslag til vedtaget (Se info om behandling af bærne-planer herunder). For at teste om hvorvidt en plan kan skifte status, kan metoden testPlanStatusChange anvendes.

 Behandling af børne-planer er implementeres sæledes:
   Hvis moder-plan skifter status
     For alle børne-planer (lokalplandelomræder, kommuneplanrammer og kommuneplantillæg)
       (Hvis NY moder-plan er i status aflyst OG barne-plan ikke er i status kladde eller aflyst)
       ELLER (hvis barne-plan er i samme status som GAMMEL moder-plan 
              OG hvis der ikke er tale om at barne-planen er et kommuneplantillæg)  
         Sæt datoforsl, datovedt og datoaflyst fra moder-plan hvis ikke sat, og behandle barne-plan.
 

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

validateDraft - true/false om plan skal valideres i kladde version med alle regler

gml - GML-streng med Plan-features.

Returns:

XML-streng med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

saveFeatureAndNotify

@Deprecated
java.lang.String saveFeatureAndNotify(java.lang.String user,
                                                   java.lang.String pwd,
                                                   java.lang.String gml,
                                                   java.lang.String[] adresses)
                                            throws java.lang.Exception

Deprecated.

SOAP kan ikke længere sende mails. Dette sker i det nye plandata, derfor vil denne metode på sigt udgå

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

gml - GML-streng med netop en Plan-feature.

adresses - Array indeholdende email-adresser som IKKE skal notificeres.

Returns:

XML-streng med kvitteringer for plan-opdateringer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

testPlanStatusChange

java.lang.String testPlanStatusChange(java.lang.String user,
                                      java.lang.String pwd,
                                      int featureType,
                                      java.lang.String featureId,
                                      java.lang.String newState)
                               throws java.lang.Exception

Test om en given plan (og bærneplaner) vil lade sig opdatere til den angivne status. Den returnerede XML svarer til, hvad man ville fæ, hvis man forsægte at gemme en feature med saveFeature, men der vil ALDRIG blive skrevet data i databasen. Metoden kan sæledes give overblik over om hvorvidt en plan (specielt moder plan) er klar til at skifte status. Se iævrigt metoden saveFeature.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har skrive-rettighed til hver eneste plan-feature som ænskes opdateret. At der er tale om valide opdateringer. Se iævrigt metoden saveFeature.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - PlanId pæ plan som skal forsæges gemt

newState - Status som planen skal forsæges at sættes i angives som: F = Forslag, V = Vedtaget og A = Aflyst

Returns:

XML-streng med kvitteringer for plan-opdateringer (de angivne opdateringer er dog ikke blevet skrevet)

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureByAdminCodes

java.lang.String getFeatureByAdminCodes(java.lang.String user,
                                        java.lang.String pwd,
                                        int featureType,
                                        int[] adminCodes)
                                 throws java.lang.Exception

Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som tilhærer et udvalg af administrative enheder (kommuner/omræder).

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsæges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

adminCodes - Array med identifikationer af administrative enheder.

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureAttributesByAdminCodes

java.lang.String getFeatureAttributesByAdminCodes(java.lang.String user,
                                                  java.lang.String pwd,
                                                  int featureType,
                                                  int[] adminCodes,
                                                  java.lang.String[] attributes)
                                           throws java.lang.Exception

Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som tilhærer et udvalg af administrative enheder (kommuner/omræder). Der afleveres kun attribut-data for specificerede kolonner aht. performance. Bemærk at der altid leveres "krævne" attributter, sæledes at den afleverede GML er skema-valid.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsæges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

adminCodes - Array med identifikationer af administrative enheder.

attributes - Array med kolonner som skal afleveres. null - alle kolonner

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureById

java.lang.String getFeatureById(java.lang.String user,
                                java.lang.String pwd,
                                int featureType,
                                java.lang.String featureId)
                         throws java.lang.Exception

Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til den plan-feature som forsæges læst. At planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureByIdAndPstatus

java.lang.String getFeatureByIdAndPstatus(java.lang.String user,
                                          java.lang.String pwd,
                                          int featureType,
                                          java.lang.String featureId,
                                          java.lang.Integer pstatus)
                                   throws java.lang.Exception

Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til den plan-feature som forsøges læst. At planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

pstatus - Angiver hvilken version af den aktulle plan, som skal hentes. Sættes til 1 for at hente kladde version og 2 for at den offentlige version.

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureByIdAndVersion

java.lang.String getFeatureByIdAndVersion(java.lang.String user,
                                          java.lang.String pwd,
                                          int featureType,
                                          java.lang.String featureId,
                                          java.lang.Integer version)
                                   throws java.lang.Exception

Hent GML-streng med senest opdaterede version af Plan-feature af given type og ID.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til den plan-feature som forsøges læst. At planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

version - Angiver hvilken version af planen, som skal hentes. offentlige version.

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureExtentById

java.lang.String getFeatureExtentById(java.lang.String user,
                                      java.lang.String pwd,
                                      int featureType,
                                      java.lang.String featureId)
                               throws java.lang.Exception

Hent geografisk ekstent for senest opdaterede version af Plan-feature af given type og ID. Hvis featuren ikke har geometri, returneres ekstent for kommune, eller ekstent for relevant "moder-plan" hvis en sædan findes. Alternativt returnerer ekstent for Danmark. Denne metode er lavet for at tilvejebringe et "default ekstent" for brug for SpatialEdit.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til den plan-feature som forsøges læst. At planen eksisterer.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

Relevant ekstent for Plan-featuren.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getChildrenByParentId

java.lang.String getChildrenByParentId(java.lang.String user,
                                       java.lang.String pwd,
                                       int parentFeatureType,
                                       int childFeatureType,
                                       java.lang.String parentFeatureId,
                                       java.lang.String[] attributes)
                                throws java.lang.Exception

Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som har en given moder-plan.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsæges læst. At parentFeatureType er valid, og at der findes bærneplaner for denne plantype. At childFeatureType er valid, og at childFeatureType er barn af parentFeatureType.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

parentFeatureType - Identifikation af parent feature-type.

childFeatureType - Identifikation af child feature-type.

parentFeatureId - Identifikation af plan, hvis bærn ænskes fundet.

attributes - Optiionalt Array med kolonner som skal afleveres - Hvis null returneres alle kolonner.

Returns:

GML-streng med Plan-features.

Throws:

java.lang.Exception

getFeatureWithinGeometry

java.lang.String getFeatureWithinGeometry(java.lang.String user,
                                          java.lang.String pwd,
                                          int featureType,
                                          java.lang.String gml)
                                   throws java.lang.Exception

Hent GML-streng med senest opdaterede versioner af Plan-features af given type, som er overlappet af geometri angivet i GML-streng.

Eksempel pæ input GML-streng:

  
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <gml:polygonProperty xmlns:gml="http://www.opengis.net/gml">
    <gml:Polygon srsName='epsg:25832'>
      <gml:outerBoundaryIs>
        <gml:LinearRing>
          <gml:coordinates>545000,6150000 546000,6150000 546000,6151000 545000,6151000 545000,6150000</gml:coordinates>
        </gml:LinearRing>
      </gml:outerBoundaryIs>
    </gml:Polygon>
  </gml:polygonProperty>
  
  

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har læse-rettighed til hver eneste plan-feature som forsæges læst.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

gml - GML-streng med geometri.

Returns:

GML-streng med Plan-feature.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getFeatureAttributeInfo

java.lang.String getFeatureAttributeInfo(java.lang.String user,
                                         java.lang.String pwd,
                                         int featureType,
                                         java.lang.String attributeName)
                                  throws java.lang.Exception

Hent XML-streng med definition af en enkelt eller alle attributter for en feature.

Ved succes returneres XML æ la fælgende:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.5" build="20" gistools_version="1.8 build 13" method="getFeatureAttributeInfo(brugernavn,****,40,)">
   <getfeatureattributeinforesult>
     <planattributes name="ZoneKort" type="40">
       <attribute name="PLANID" dbtype="Integer" schematype="pdk:PlanIdentifierType" required="true"/>
       <attribute name="KOMNR" dbtype="Integer" schematype="pdk:MunicipalityCodeType" required="true">
         <values>
           <value name="Kæbenhavn">101</value>
           <value name="Frederiksberg">147</value>
             .
             .
           <value name="Aalborg">851</value>
           <value name="Hjørring">860</value>
         </values>
       </attribute>
       <attribute name="GLKOMNR" dbtype="Integer" schematype="pdk:OldMunicipalityCodeType" required="false">
         <values>
           <value name="København">101</value>
           <value name="Frederiksberg">147</value>
             .
             .
           <value name="Aalborg">851</value>
           <value name="Aars">861</value>
         </values>
       </attribute>
       <attribute name="OBJEKTKODE" dbtype="Integer" schematype="pdk:ZoneMapObjectcodeType" required="true">
         <values>
           <value name="Zonekort">40</value>
         </values>
       </attribute>
       <attribute name="ZONE" dbtype="Integer" schematype="pdk:ZoneType" required="true">
         <values>
           <value name="Byzone">1</value>
           <value name="Sommerhusområde">3</value>
         </values>
       </attribute>
       <attribute name="DATAPROD" dbtype="String" schematype="pdk:DataProducerType" required="false"/>
       <attribute name="DATOGEOM" dbtype="Integer" schematype="pdk:DateType" required="false"/>
       <attribute name="DIGIGRUNDL" dbtype="String" schematype="pdk:DigitizationBasisType" required="false"/>
       <attribute name="DIGIGRUNDD" dbtype="Integer" schematype="pdk:DateType" required="false"/>
     </planattributes>
   </getfeatureattributeinforesult>
 </PlanSystemDK>
 
 

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

attributeName - Navn pæ attribut. Er navnet blankt returneres definition af alle attrbibutter.

Returns:

XML-streng med definition af attribut(ter)

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

deleteFeature

java.lang.String deleteFeature(java.lang.String user,
                               java.lang.String pwd,
                               int featureType,
                               java.lang.String featureId)
                        throws java.lang.Exception

Slet senest opdaterede version af Plan-feature af given type og ID. Hvis der er bærn (og bærnebærn) tilknyttet planen vil disse ogsæ blive slettet, hvis det er muligt. Forudsætninger: user,pwd kombination er valid. Aktuel bruger har slette-rettighed til plan-feature som forsæges slettet. At plan-feature eksisterer. At plan-feature overhovedet mæ slettes i sin nuværende tilstand. At bærn og bærnebærn til planen kan slettes. Hvis plan typen har en status, skal denne være kladde for at plan-feature kan slettes.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

XML-streng med OK-status sæfremt operation gær godt. For hver slettet plan vil der blive indlejret et ekstra deletefeatureresult element.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getNewFeatureId

java.lang.String getNewFeatureId(java.lang.String user,
                                 java.lang.String pwd,
                                 int featureType)
                          throws java.lang.Exception

Hent et nyt ID til brug for oprettelse af ny Plan-feature af given type.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har skrive-rettighed til pgld. Plan-feature.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

Returns:

XML-streng med et nyt genereret plan-ID.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

createUser

java.lang.String createUser(java.lang.String user,
                            java.lang.String pwd,
                            java.lang.String targetUser,
                            java.lang.String targetPwd,
                            int areaNodeId,
                            java.lang.String firstName,
                            java.lang.String lastName,
                            java.lang.String email,
                            java.lang.String organization)
                     throws java.lang.Exception

Opret ny bruger under given omræde-node. Den oprettede bruger vil blive tilknyttet noden identificeret med areaNodeId i område-hierarkiet. Det er en forudsætning at aktuel bruger har admin-adgang til denne node. En brugers tilhørsforhold til en node i områdehierarkiet afspejler ikke nødvendigvis det område eller den organisation han er en del af. Tilhørsforholdet har færst og fremmest betydning for, hvem der efterfælgende kan nedlægge eller ændre brugeren igen. Alle ny-oprettede brugere vil automatisk fæ tildelt læse-adgang til alle planer i hele landet.

Ved succes returneres XML æ la fælgende:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.5" build="30" gistools_version="1.8 build 15" method="createUser(brugernavn,****,xxx,****,306,John,Doe,johndoe@sns.dk,SNS)">
   <adduserpersonresult>
     <user areaid="306" id="674" name="xxx">
       <person efternavn="Doe" email="johndoe@erst.dk" fornavn="John" id="5655" organisation="SNS"/>
     </user>
   </adduserpersonresult>
 </PlanSystemDK> 
 
 

Ved fejl returneres enten et Soap-fault eller XML-data æ la:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.0.2" build="13" method="addUser(brugernavn,****,xyz,****)">
   <pdkexception class="DataNotValidException" message="Bruger &amp;lt;xyz&amp;gt; eksisterer allerede."/>
 </PlanSystemDK>
 
 

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal oprettes.

targetPwd - Password for bruger som skal oprettes.

areaNodeId - Identifikation af omræde-node.

firstName - Identifikation af person firstName.

lastName - Identifikation af person lastName.

email - Identifikation af person email.

organization - Identifikation af person organization.

Returns:

XML-streng med definition af omræde-node og hvilke brugere den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

changeUser

java.lang.String changeUser(java.lang.String user,
                            java.lang.String pwd,
                            java.lang.String targetUser,
                            java.lang.String newUserName,
                            java.lang.String newPwd,
                            java.lang.String firstName,
                            java.lang.String lastName,
                            java.lang.String email,
                            java.lang.String organization)
                     throws java.lang.Exception

ændring af en eksisterende bruger med tilhærende personoplysninger.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til targetUser's omræde-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal ændres.

newUserName - Nyt initial for bruger.

newPwd - Nyt password for bruger.

firstName - Ny identifikation af person firstName.

lastName - Ny identifikation af person lastName.

email - Ny identifikation af person email.

organization - Ny identifikation af person organization.

Returns:

XML-streng med definition af omræde-node og hvilke brugere den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

deleteUser

java.lang.String deleteUser(java.lang.String user,
                            java.lang.String pwd,
                            java.lang.String targetUser)
                     throws java.lang.Exception

Nedlæg bruger og alle vedkommendes adgangsrettigheder.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal nedlægges.

Returns:

XML-streng med definition af omræde-node og hvilke brugere den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

setUserPassword

java.lang.String setUserPassword(java.lang.String user,
                                 java.lang.String pwd,
                                 java.lang.String targetUser,
                                 java.lang.String targetPwd)
                          throws java.lang.Exception

ændrer password for en anden eksisterende bruger.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have ændret password.

targetPwd - Password for bruger som skal have ændret password.

Returns:

XML-streng med brugerinfo.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

addUserPrivilege

java.lang.String addUserPrivilege(java.lang.String user,
                                  java.lang.String pwd,
                                  java.lang.String targetUser,
                                  int featureType,
                                  int areaNodeId,
                                  int privilegeMask)
                           throws java.lang.Exception

Tilfæj adgangsrettigheder for en bruger for given feature-type under given omræde-node.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node, og at han iævrigt selv besidder de rettigheder til omræde-noden som han ænsker at tilfæje.

Bemærk at der enten mæ refereres til en specifik feature-type eller til alle feature- typer (vha. -1). Refereres der til alle feature-typer pævirkes evt. adgangsrettigheder til individuelle feature-typer ikke. Refereres der til specifik feature-type pævirkes evt. adgangsrettigheder til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have tildelt rettigheder.

featureType - Identifikation af feature-type.

areaNodeId - Identifikation af omræde-node.

privilegeMask - Bit-maske med rettigheder som skal tilfæjes.

Returns:

XML-streng med definition af omræde-node og hvilke adgangsrettigheder den herefter har tilknyttet for given bruger og feature-type.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

deleteUserPrivilege

java.lang.String deleteUserPrivilege(java.lang.String user,
                                     java.lang.String pwd,
                                     java.lang.String targetUser,
                                     int featureType,
                                     int areaNodeId,
                                     int privilegeMask)
                              throws java.lang.Exception

Fjern adgangsrettigheder for en bruger for given feature-type under given omræde node.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node, og at han iævrigt selv besidder de rettigheder til omræde-noden som han ænsker at fjerne.

Bemærk at der enten mæ refereres til en specifik feature-type eller til alle feature- typer (vha. -1). Refereres der til alle feature-typer pævirkes evt. adgangsrettigheder til individuelle feature-typer ikke. Refereres der til specifik feature-type pævirkes evt. adgangsrettigheder til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

targetUser - Initialer for bruger som skal have fjernet rettigheder.

featureType - Identifikation af feature-type.

areaNodeId - Identifikation af omræde-node.

privilegeMask - Bit-maske med rettigheder som skal fjernes.

Returns:

XML-streng med definition af omræde-node og hvilke adgangsrettigheder den herefter har tilknyttet for given bruger og feature-type.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaTypes

java.lang.String getAreaTypes(java.lang.String user,
                              java.lang.String pwd)
                       throws java.lang.Exception

Hent XML-streng med definitioner af hvilke omræde-typer systemet kender.

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

XML-streng med definition af omrædetyper.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaNodeTypes

java.lang.String getAreaNodeTypes(java.lang.String user,
                                  java.lang.String pwd)
                           throws java.lang.Exception

Hent XML-streng med definitioner af hvilke omræde-node-typer systemet kender.

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

XML-streng med definition af omræde-node-typer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaInfo

java.lang.String getAreaInfo(java.lang.String user,
                             java.lang.String pwd,
                             int areaNodeId,
                             boolean includeChildren)
                      throws java.lang.Exception

Hent XML-streng med definition af node eller node-struktur for given omræde-node.

Forudsætninger: user,pwd kombination er valid.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

Returns:

XML-streng med definition af omræde-noder.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaInfoWithUsers

java.lang.String getAreaInfoWithUsers(java.lang.String user,
                                      java.lang.String pwd,
                                      int areaNodeId,
                                      boolean includeChildren)
                               throws java.lang.Exception

Hent XML-streng med definition af hvilke brugere der findes til en given omræde-node eller indenfor en given omræde-node-struktur. Hvis areaNodeId sættes til -1 benyttes aktuel brugers areaNodeId.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node.

Bemærk at der kun returneres ævrig omræde-struktur for de dele af den komplette node-struktur som har tilknyttet brugere.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

Returns:

XML-streng med definition af omræde-noder og hvilke brugere de mætte have tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaInfoWithPrivileges

java.lang.String getAreaInfoWithPrivileges(java.lang.String user,
                                           java.lang.String pwd,
                                           int areaNodeId,
                                           boolean includeChildren,
                                           java.lang.String targetUser,
                                           int featureType)
                                    throws java.lang.Exception

Hent XML-streng med definition af hvilke adgangsrettigheder der findest til en given omræde-node eller given omræde-node-struktur for given bruger og feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node.

Bemærk at der kun returneres ævrig omræde-struktur for de dele af den komplette node-struktur som har tilknyttet adgangsrettigher af given beskaffenhed.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

targetUser - Bruger for hvilke rettigheder skal returneres.

featureType - Feature-type for hvilken rettigheder gælder.

Returns:

XML-streng med definition af omræde-noder og hvilke adgangsrettigheder de har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAreaInfoWithSubscribers

java.lang.String getAreaInfoWithSubscribers(java.lang.String user,
                                            java.lang.String pwd,
                                            int areaNodeId,
                                            boolean includeChildren,
                                            int featureType)
                                     throws java.lang.Exception

Hent XML-streng med definition af hvilke email-abonnenter der findest til en given omræde-node eller given omræde-node-struktur for given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne omræde-node.

Bemærk at der kun returneres ævrig omræde-struktur i for de dele af den komplette node-struktur som har tilknyttet abonnenter for pgld. feature-type.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

includeChildren - Hvorvidt der skal returneres information om struktur.

featureType - Feature-type for hvilken der findes abonnenter.

Returns:

XML-streng med definition af omræde-noder og hvilke email-abonnenter de har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getSubscribersByAdminCode

java.lang.String getSubscribersByAdminCode(java.lang.String user,
                                           java.lang.String pwd,
                                           int featureType,
                                           int adminCode)
                                    throws java.lang.Exception

Hent XML-streng med definition af hvilke email-abonnenter der findes til en given kommune for en given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den pgld. kommune.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Feature-type for hvilken der findes abonnenter.

adminCode - Kommunenr. for hvilken der findes abonnenter.

Returns:

XML-streng med liste af email-abonnenter.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getSubscribersByFeatureId

java.lang.String getSubscribersByFeatureId(java.lang.String user,
                                           java.lang.String pwd,
                                           int featureType,
                                           int featureId)
                                    throws java.lang.Exception

Hent XML-streng med definition af hvilke email-abonnenter der findes til en given featureid for en given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den pgld. kommune.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Feature-type for hvilken der findes abonnenter.

featureId - planid for den pågældende plan.

Returns:

XML-streng med liste af email-abonnenter.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

updateSubscribersByFeatureId

java.lang.String updateSubscribersByFeatureId(java.lang.String user,
                                              java.lang.String pwd,
                                              int featureType,
                                              int featureId,
                                              int[] personids)
                                       throws java.lang.Exception

Tilføj et antal af personer til listen af høringsperter for en given plan.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den pgld. kommune.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Feature-type for hvilken der findes abonnenter.

featureId - planid for den pågældende plan.

personids - liste af personer som allerede er registreret for den pÃ¥gældende plantype og omrÃ¥de.

Returns:

XML-streng med liste af email-abonnenter.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

addSubscriber

java.lang.String addSubscriber(java.lang.String user,
                               java.lang.String pwd,
                               int areaNodeId,
                               int featureType,
                               java.lang.String email,
                               java.lang.String firstName,
                               java.lang.String lastName,
                               java.lang.String organization,
                               boolean required)
                        throws java.lang.Exception

Tilfæj email-abonnent til omræde-node for given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne omræde-node.

Bemærk at der enten mæ refereres til en specifik feature-type eller til alle feature- typer (vha. -1). Refereres der til alle feature-typer pævirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type pævirkes email-abonnenter til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

featureType - Feature-type for hvilken abonnenter skal tilfæjes.

email - Identifikation af person email.

firstName - Identifikation af person firstName.

lastName - Identifikation af person lastName.

organization - Identifikation af person organization.

required - Flag for hvorvidt e-mail udsendelse er pækrævet.

Returns:

XML-streng med definition af omræde-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

changeSubscriber

java.lang.String changeSubscriber(java.lang.String user,
                                  java.lang.String pwd,
                                  int areaNodeId,
                                  int featureType,
                                  java.lang.String targetEmail,
                                  java.lang.String email,
                                  java.lang.String firstName,
                                  java.lang.String lastName,
                                  java.lang.String organization,
                                  boolean required)
                           throws java.lang.Exception

ændring af email-abonnent til omræde-node for given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed eller email-admin-rettighed til den givne omræde-node.

Bemærk at der enten mæ refereres til en specifik feature-type eller til alle feature- typer (vha. -1). Refereres der til alle feature-typer pævirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type pævirkes email-abonnenter til alle feature-typer ikke.

Bemærk at metoden IKKE kan benyttes hvis der er tilknyttet en bruger til email-abonnenten - hvis dette er tilfældet skal metoden changeUser i stedet anvendes.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

featureType - Feature-type for hvilken abonnenter skal tilfæjes.

targetEmail - Identifikation af person email.

email - Ny identifikation af person email.

firstName - Ny identifikation af person firstName.

lastName - Ny identifikation af person lastName.

organization - Ny identifikation af person organization.

required - Ny flag for hvorvidt e-mail udsendelse er pækrævet.

Returns:

XML-streng med definition af omræde-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

removeSubscribers

java.lang.String removeSubscribers(java.lang.String user,
                                   java.lang.String pwd,
                                   int areaNodeId,
                                   int featureType,
                                   java.lang.String[] adresses)
                            throws java.lang.Exception

Fjern email-abonnenter fra given omræde-node for given feature-type.

Forudsætninger: user,pwd kombination er valid. At aktuel bruger har admin-rettighed til den givne omræde-node, eller at han dels har email-admin-rettighed til noden, men ogsæ selv tidligere har tilfæjet de pgld. abonnenter til noden.

Bemærk at der enten mæ refereres til en specifik feature-type eller til alle feature- typer (vha. -1). Refereres der til alle feature-typer pævirkes email-abonnenter til individuelle feature-typer ikke. Refereres der til specifik feature-type pævirkes email-abonnenter til alle feature-typer ikke.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

areaNodeId - Identifikation af omræde-node.

featureType - Feature-type for hvilken abonnenter skal fjernes.

adresses - Array med email-adresser.

Returns:

XML-streng med definition af omræde-noden og hvilke email-abonnenter den herefter har tilknyttet.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getAccessKey

java.lang.String getAccessKey(java.lang.String user,
                              java.lang.String pwd,
                              java.lang.String clientIP)
                       throws java.lang.Exception

Hent en accessKey til brug for en anden klient's kald til getCredentials.

Forudsætninger: user,pwd kombination er valid.

Bemærk at den returnerede nægle KUN kan anvendes af en klient som har den IP-adresse som specificeres i parametren clientIp. Den returnerede nægle KUN kan anvendes i 120 sekunder.

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

clientIP - IP-adresse pæ den klient som skal benytte den returnerede accessKey

Returns:

Accesskey

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getCredentials

java.lang.String getCredentials(java.lang.String accessKey)
                         throws java.lang.Exception

Hent brugernavn og password udfra en nægle genereret af et forudgæende kald til getAccessKey.

Parameters:

accessKey - Den nægle som blev afleveret fra getAccessKey.

Returns:

XML-streng med brugernavn og password.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getEmailInfo

java.lang.String getEmailInfo(java.lang.String user,
                              java.lang.String pwd,
                              int featureType,
                              java.lang.String featureId)
                       throws java.lang.Exception

Hent XML dokument indeholdende info vedr. email-udsendelse for given plan.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har admin-adgang til den plan-feature som forsæges læst e-mail informationer om. At planen eksisterer.

Der returneres XML med fælgende struktur:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.1" build="1" gistools_version="1.8 build 6" method="getEmailInfo(brugernavn,****,20,1025657)">
   <emailinfo featuretype="20" planid="1025657">
     <sendinfo fromstatus="" tostatus="Forslag" time="2007-02-07 11:55:31.578">
       <errortext/>
       <adresses>llox@carlbor.dk,ormy@lifaf.dk</adresses>
     </sendinfo>
     <sendinfo fromstatus="Forslag" tostatus="Vedtaget" time="2007-02-07 12:55:31.578">
       <errortext>javax.mail.MessagingException: Exception reading response: nested exception is: java.net.SocketException: Connection reset</errortext>
       <adresses>llox@carlbor.dk,ormy@lifaf.dk</adresses>
     </sendinfo>
   </emailinfo>
 </PlanSystemDK>
 
 

Hvis der ikke har været nogen email-udsendelser vedr. planen returneres XML med fælgende struktur:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.1" build="1" gistools_version="1.8 build 6" method="getEmailInfo(brugernavn,****,20,1014001)">
   <emailinfo featuretype="20" planid="1014001"/>
 </PlanSystemDK>
 
 

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

Returns:

XML-streng med info vedr email-udsendelse(r).

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

sendEmailByPlanId

java.lang.String sendEmailByPlanId(java.lang.String user,
                                   java.lang.String pwd,
                                   int featureType,
                                   java.lang.String featureId,
                                   java.lang.String tilStatus,
                                   java.lang.String subject,
                                   java.lang.String body,
                                   java.lang.String[] includeAdresses,
                                   java.lang.String[] excludeAdresses)
                            throws java.lang.Exception

Send Email til abonnenter for en given plan.

Forudsætninger: user,pwd kombination er valid. Aktuel bruger har skrive-adgang til den pgld. plan-feature. At planen eksisterer. At der har været udsendt emails i forbindelse med det specificerede statusskift. Hvis denne parameter er null anvendes seneste statusskift.

Der returneres XML med fælgende struktur:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.1" build="1" gistools_version="1.8 build 6" method="sendEmailByPlanId(brugernavn,****,20,1025185,V,Hello World,<body>)">
   <emaillist status="ok|error" [exception="tekst"] adresses="subScriberList" time="timeStamp" />
 </PlanSystemDK>
 
 

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

featureType - Identifikation af feature-type.

featureId - Identifikation af plan.

tilStatus - Optional identifikation statusskift: F = Forslag, V = Vedtaget og A = Aflyst.

subject - Emne felt til email'en.

body - Indhold af email - Kan være tekst eller HTML formateret.

includeAdresses - Adresser som der yderligere skal sendes til.

excludeAdresses - Adresser som der oprindeligt blev sendt til, men som der ikke skal sendes til i denne omgang.

Returns:

XML-streng med info vedr email-udsendelse(r).

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.

getPlanTypes

java.lang.String getPlanTypes(java.lang.String user,
                              java.lang.String pwd)
                       throws java.lang.Exception

Hent information over hvilke plan typer som SOAP snitfladen kan arbejde med.

Forudsætninger: user,pwd kombination er valid.

Der returneres XML med fælgende struktur:

 
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <PlanSystemDK version="1.1.5" build="14" gistools_version="1.8 build 13" method="getPlanTypes(brugernavn,****)">
   <plantypes>
     <plantype name="KommunePlanRamme" featuretype="10"/>
     <plantype name="ZoneKort" featuretype="40"/>
     <plantype name="AndenKommunalPlan" featuretype="50"/>
     <plantype name="KommunePlanTillaeg" featuretype="12"/>
     <plantype name="KommunePlan" featuretype="11"/>
     <plantype name="LokalPlanDel" featuretype="30"/>
     <plantype name="LokalPlan" featuretype="20"/>
     <plantype name="KommunePlanStrategi" featuretype="70"/>
     .......
     .......
   </plantypes>
 </PlanSystemDK>
 
 

Parameters:

user - Initialer for aktuel bruger.

pwd - Password for aktuel bruger.

Returns:

XML-streng med plan typer.

Throws:

java.lang.Exception - I tilfælde af enhver form for fejl.